Update user settings (SAML)
{ updateUserSaml }
Updates the user details in the system for SAML Authentication.
Method
/API3/access/updateUserSaml
- Enterprise Admin
- Domain Admin
Input Parameters
Name
updateUserSaml
Object Type
Description
The object used to update a SAML user.
Output Response
Successful Result Code
200
Response Type
Description of Response Type
Generic API response object with success or failure flag and related messages.
Notes
Used only for user added with SAML authentication provider.
Code Snippets
Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.
TypeScript
Curl
Java
C#
Python
PHP
curl -X POST \
-H "paToken: [[apiKey]]" \
-H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
-H "Content-Type: application/json" \
"http://Your.Server.URL/API3/access/updateUserSaml" \
-d '{
"lastName" : "lastName",
"proxyAccount" : "proxyAccount",
"principalName" : "principalName",
"userName" : "userName",
"firstName" : "firstName",
"password" : "password",
"roleIds" : [ "roleIds", "roleIds" ],
"phone" : "phone",
"profileId" : "profileId",
"tenantId" : "tenantId",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"proxy2" : "proxy2",
"email" : "email"
}'
import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.AccessServiceApi;
import java.util.*;
import java.time.*;
public class AccessServiceApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://Your.Server.URL/");
// Configure API key authorization: paToken
ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
paToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//paToken.setApiKeyPrefix("Token");
// Create an instance of the API class
AccessServiceApi apiInstance = new AccessServiceApi();
// Initialize the updateUserSaml parameter object for the call
UpdateUserSamlObject updateUserSaml = ; // Create the input object for the operation, type: UpdateUserSamlObject
try {
ModifiedItemsResult result = apiInstance.updateUserSaml(updateUserSaml);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccessServiceApi#updateUserSaml");
e.printStackTrace();
}
}
}
import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";
// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.AccessServiceApi("http://Your.Server.URL")
// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");
const updateUserSaml = ; // {UpdateUserSamlObject}
api.updateUserSaml(updateUserSaml).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;
public class updateUserSamlExample
{
public static void Main()
{
Configuration conf = new Configuration();
conf.BasePath = "http://Your.Server.URL/";
// Configure API key authorization: paToken
conf.ApiKey.Add("paToken", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// conf.ApiKeyPrefix.Add("paToken", "Bearer");
GlobalConfiguration.Instance = conf;
// Create an instance of the API class
var apiInstance = new AccessServiceApi();
// Initialize the updateUserSaml parameter object for the call
var updateUserSaml = new UpdateUserSamlObject(); // UpdateUserSamlObject |
try {
// Updates the user details in the system for SAML Authentication.
ModifiedItemsResult result = apiInstance.updateUserSaml(updateUserSaml);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling AccessServiceApi.updateUserSaml: " + e.Message );
}
}
}
import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import AccessServiceApi
from pprint import pprint
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
with com.pyramidanalytics.ApiClient(api_config) as api_client:
# Create an instance of the API class
api_instance = AccessServiceApi(api_client)
# Initialize the updateUserSaml parameter object for the call
updateUserSaml = # UpdateUserSamlObject |
try:
# Updates the user details in the system for SAML Authentication.
api_response = api_instance.update_user_saml(updateUserSaml)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccessServiceApi->updateUserSaml: %s\n" % e)
<?php
require_once(__DIR__ . '/vendor/autoload.php');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');
// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AccessServiceApi();
$updateUserSaml = ; // UpdateUserSamlObject |
try {
$result = $api_instance->updateUserSaml($updateUserSaml);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccessServiceApi->updateUserSaml: ', $e->getMessage(), PHP_EOL;
}
?>